fullfilment-ux
TMF-651 AgreementSecureRetrieval
==> TMF-651
Fetch TOBR request details for display in SF Portal
URL
https://[localhost]:[port]/fullfilment-ux/v1/{businessId}/agreementSecureRetrievalurl Param
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
Request
curl --location 'https://nonprod.esb.cloud.lla.com/test/fullfilment-ux/fullfilment-ux/v1/PR/agreementSecureRetrieval' \
--header 'client_id: XXXXXX' \
--header 'client_secret: XXXXX' \
--header 'X-Correlation-ID: {guid}' \
--header 'Content-Type: application/json' \
--data '{
"id": "47728912",
"agreementType": "linesToTransfer",
"characteristic": [
{
"name": "verificationCode",
"value": "123",
"valueType": "string"
}
]
}'Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
[ 200 ]
OK - The request was successfully processed and the digital identity validation result is returned.
{
"id": "guygcuYQDCpiuqwhdpoHWEOFUHeofhpoDHWPIWAH",
"name": "John Doe",
"characteristic": [
{
"name": "masterCaseId",
"value": "787298329",
"valueType": "string"
}
],
"agreementAuthorization": [
{
"state": false,
"characteristic": [
{
"name": "authorization",
"value": "auth_primary_holder",
"valueType": "string"
}
]
},
{
"state": false,
"characteristic": [
{
"name": "authorization",
"value": "financial_responsibility",
"valueType": "string"
}
]
},
{
"state": false,
"characteristic": [
{
"name": "authorization",
"value": "past_due_balance",
"valueType": "string"
}
]
},
{
"state": false,
"characteristic": [
{
"name": "authorization",
"value": "promotion_impact",
"valueType": "string"
}
]
},
{
"state": false,
"characteristic": [
{
"name": "authorization",
"value": "authorization_validity",
"valueType": "string"
}
]
},
{
"state": false,
"characteristic": [
{
"name": "authorization",
"value": "esign_consent",
"valueType": "string"
}
]
},
{
"state": false,
"characteristic": [
{
"name": "authorization",
"value": "terms_acknowledgement",
"valueType": "string"
}
]
}
],
"engagedParty": [
{
"id": "******1234",
"name": "John Doe",
"role": "accountOwner",
"@referredType": "Individual"
}
],
"agreementType": "linesToTransfer",
"relatedParty": [
{
"name": "Patrick Jane",
"role": "newResponsibleParty",
"@type": "RelatedPartyWithContactInfo",
"@referredType": "Individual",
"@schemaLocation": "https://tmf-api/agreementManagement/v4/agreement",
"contact": [
{
"mediumType": "BillingAddress",
"characteristic": [
{
"name": "BillingAddress",
"value": {
"streat1": "Calle San Jose 123, San Juan, PR 00901"
},
"valueType": "Object"
}
]
},
{
"mediumType": "EmailAddress",
"characteristic": [
{
"name": "EmailAddress",
"value": {
"emailAddress": "patrick.jane@gmail.com"
},
"valueType": "Object"
}
]
},
{
"mediumType": "TelephoneNumber",
"characteristic": [
{
"name": "TelephoneNumber",
"value": {
"phoneNumber": "1234567890"
},
"valueType": "Object"
}
]
}
]
}
],
"agreementItem": [
{
"product": {
"id": "L001",
"name": "iPhone 14 Pro",
"characteristic": [
{
"name": "msisdn",
"value": "(555) 123-4567",
"valueType": "string"
},
{
"name": "installmentBalance",
"value": {
"unit": "USD",
"value": 1200,
"@type": "Money"
},
"valueType": "object"
},
{
"name": "selected",
"value": false,
"valueType": "boolean"
}
]
}
},
{
"product": {
"id": "L002",
"name": "Galaxy S23",
"characteristic": [
{
"name": "msisdn",
"value": "(555) 987-6643",
"valueType": "string"
},
{
"name": "installmentBalance",
"value": {
"unit": "USD",
"value": 500,
"@type": "Money"
},
"valueType": "object"
},
{
"name": "selected",
"value": false,
"valueType": "boolean"
}
]
}
},
{
"product": {
"id": "L003",
"name": "Tablet Line",
"characteristic": [
{
"name": "msisdn",
"value": "(555) 222-1111",
"valueType": "string"
},
{
"name": "installmentBalance",
"value": {
"unit": "USD",
"value": 150,
"@type": "Money"
},
"valueType": "object"
},
{
"name": "selected",
"value": false,
"valueType": "boolean"
}
]
}
},
{
"product": {
"id": "L004",
"name": "Smart Watch",
"characteristic": [
{
"name": "msisdn",
"value": "(555) 333-4444",
"valueType": "string"
},
{
"name": "installmentBalance",
"value": {
"unit": "USD",
"value": 50,
"@type": "Money"
},
"valueType": "object"
},
{
"name": "selected",
"value": false,
"valueType": "boolean"
}
]
}
}
]
}Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| id | String | Unique id of the consent | Y |
| agreementType | String | Type of the agreement | Y |
| characteristic | array | Describes a given characteristic of an object or entity through a name/value pair. | Y |
| characteristic.name | String | Name of the characteristic | Y |
| characteristic.valueType | String | Data type of the value of the characteristic | Y |
| characteristic.value | array | The value of the characteristic | Y |